/*
* Copyright 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.compose.foundation.lazy
import androidx.compose.foundation.assertNotNestingScrollableContainers
import androidx.compose.foundation.gestures.scrollable
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.calculateEndPadding
import androidx.compose.foundation.layout.calculateStartPadding
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.runtime.saveable.rememberSaveableStateHolder
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clipToBounds
import androidx.compose.ui.gesture.scrollorientationlocking.Orientation
import androidx.compose.ui.layout.SubcomposeLayout
import androidx.compose.ui.platform.LocalLayoutDirection
import androidx.compose.ui.unit.LayoutDirection
internal class ItemContent(
val key: Any,
val content: @Composable() () -> Unit
)
@Composable
internal fun LazyList(
/** The total size of the list */
itemsCount: Int,
/** Modifier to be applied for the inner layout */
modifier: Modifier,
/** State controlling the scroll position */
state: LazyListState,
/** The inner padding to be added for the whole content(nor for each individual item) */
contentPadding: PaddingValues,
/** reverse the direction of scrolling and layout */
reverseLayout: Boolean,
/** The layout orientation of the list */
isVertical: Boolean,
/** The alignment to align items horizontally. Required when isVertical is true */
horizontalAlignment: Alignment.Horizontal? = null,
/** The vertical arrangement for items. Required when isVertical is true */
verticalArrangement: Arrangement.Vertical? = null,
/** The alignment to align items vertically. Required when isVertical is false */
verticalAlignment: Alignment.Vertical? = null,
/** The horizontal arrangement for items. Required when isVertical is false */
horizontalArrangement: Arrangement.Horizontal? = null,
/** The list of indexes of the sticky header items */
headerIndexes: List<Int> = emptyList(),
/** The factory defining the content for an item on the given position in the list */
itemContent: LazyItemScope.(Int) -> ItemContent
) {
val isRtl = LocalLayoutDirection.current == LayoutDirection.Rtl
// reverse scroll by default, to have "natural" gesture that goes reversed to layout
// if rtl and horizontal, do not reverse to make it right-to-left
val reverseScrollDirection = if (!isVertical && isRtl) reverseLayout else !reverseLayout
val restorableItemContent = wrapWithStateRestoration(itemContent)
val cachingItemContentFactory = remember { CachingItemContentFactory(restorableItemContent) }
cachingItemContentFactory.itemContentFactory = restorableItemContent
SubcomposeLayout(
modifier
.scrollable(
orientation = if (isVertical) Orientation.Vertical else Orientation.Horizontal,
reverseDirection = reverseScrollDirection,
controller = state.scrollableController
)
.clipToBounds()
.padding(contentPadding)
.then(state.remeasurementModifier)
) { constraints ->
constraints.assertNotNestingScrollableContainers(isVertical)
// this will update the scope object if the constrains have been changed
cachingItemContentFactory.updateItemScope(this, constraints)
val startContentPadding = if (isVertical) {
contentPadding.calculateTopPadding()
} else {
contentPadding.calculateStartPadding(layoutDirection)
}.roundToPx()
val endContentPadding = if (isVertical) {
contentPadding.calculateBottomPadding()
} else {
contentPadding.calculateEndPadding(layoutDirection)
}.roundToPx()
val mainAxisMaxSize = (if (isVertical) constraints.maxHeight else constraints.maxWidth)
val spaceBetweenItemsDp = if (isVertical) {
requireNotNull(verticalArrangement).spacing
} else {
requireNotNull(horizontalArrangement).spacing
}
val spaceBetweenItems = spaceBetweenItemsDp.roundToPx()
val itemProvider = LazyMeasuredItemProvider(
constraints,
isVertical,
this,
cachingItemContentFactory
) { index, key, placeables ->
// we add spaceBetweenItems as an extra spacing for all items apart from the last one so
// the lazy list measuring logic will take it into account.
val spacing = if (index.value == itemsCount - 1) 0 else spaceBetweenItems
LazyMeasuredItem(
index = index.value,
placeables = placeables,
isVertical = isVertical,
horizontalAlignment = horizontalAlignment,
verticalAlignment = verticalAlignment,
layoutDirection = layoutDirection,
startContentPadding = startContentPadding,
endContentPadding = endContentPadding,
spacing = spacing,
key = key
)
}
val measureResult = measureLazyList(
itemsCount,
itemProvider,
mainAxisMaxSize,
startContentPadding,
endContentPadding,
state.firstVisibleItemIndexNonObservable,
state.firstVisibleItemScrollOffsetNonObservable,
state.scrollToBeConsumed
)
state.applyMeasureResult(measureResult)
val headers = if (headerIndexes.isNotEmpty()) {
LazyListHeaders(itemProvider, headerIndexes, measureResult, startContentPadding)
} else {
null
}
layoutLazyList(
constraints,
isVertical,
verticalArrangement,
horizontalArrangement,
measureResult,
reverseLayout,
headers
)
}
}
/**
* Converts item content factory to another one which adds auto state restoration functionality.
*/
@Composable
internal fun wrapWithStateRestoration(
itemContentFactory: LazyItemScope.(Int) -> ItemContent
): LazyItemScope.(Int) -> ItemContent {
val saveableStateHolder = rememberSaveableStateHolder()
return remember(itemContentFactory) {
{ index ->
val content = itemContentFactory.invoke(this, index)
// we just wrap our original lambda with the one which auto restores the state
ItemContent(content.key) {
saveableStateHolder.SaveableStateProvider(content.key, content.content)
}
}
}
}